// --------------------------------------------------------------------------------------------------------------------
// <copyright file="CameraAgentMessage.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------
namespace Microsoft.Robotics.Vision.Runtime.Cameras
{
    using System;
    using System.Diagnostics;
    using System.Drawing;
    using System.Runtime.InteropServices;
    using System.Runtime.Serialization;

    using Microsoft.Robotics.Numerics;
    using Microsoft.Robotics.Runtime;
    using Microsoft.Robotics.Tracing;
    using Microsoft.Robotics.Vision.Cameras;

    /// <summary>
    /// Container for the data produced by a camera
    /// </summary>
    /// <typeparam name="TPixel">The type of pixel contained in the image frame"/></typeparam>
    /// <typeparam name="KParameters">The type of camera parameters</typeparam>
    [DataContract]
    public class CameraAgentMessage<TPixel, KParameters> : AgentMessage
        where TPixel : struct
        where KParameters : CameraParameters
    {
        /// <summary>
        /// Initializes a new instance of the CameraAgentMessage class
        /// </summary>
        /// <param name="originatingTime">The originating time of the message</param>
        /// <param name="image">The image produced by the camera</param>
        /// <param name="parameters">The parameters of the camera</param>
        public CameraAgentMessage(long originatingTime, ImageFrame<TPixel> image, KParameters parameters)
            : base(originatingTime)
        {
            this.ImageFrame = image;
            this.Parameters = parameters;
        }

        /// <summary>
        /// Initializes a new instance of the CameraAgentMessage class
        /// </summary>
        /// <param name="that">A camera agent message</param>
        public CameraAgentMessage(CameraAgentMessage<TPixel, KParameters> that)
            : base(that.OriginatingTime)
        {
            this.ImageFrame = that.ImageFrame;
            this.Parameters = that.Parameters;
        }

        /// <summary>
        /// Gets the image frame
        /// </summary>
        [DataMember]
        public ImageFrame<TPixel> ImageFrame { get; private set; }

        /// <summary>
        /// Gets the camera parameters
        /// </summary>
        [DataMember]
        public KParameters Parameters { get; private set; }
    }
}
